---
title: PdfOptions
summary: API reference for PdfOptions.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-09-17
library: PdfAPI.Core
reference_type: package
---

# PdfOptions

`PdfOptions` carries the per-request output-format and cleanup preferences attached to every `PdfRequest`. Its `CleanupInputFile` flag (default true when `Options` is null) determines whether [Validate a document](../../operations/op-02-validate-a-document.md) deletes the source file from disk before signature validation. ([BR-07](../../business-rules.md#br-07-input-file-cleanup-after-load))

## Purpose
- Configures the requested output format (`OutputFormat`) and whether the on-disk source file should be removed after processing (`CleanupInputFile`). ([BR-07](../../business-rules.md#br-07-input-file-cleanup-after-load))
- Signals whether the output should be prevented from transferring (`PreventOutputFileTransfer`).

## Context
- Namespace: `PdfAPI.Core`
- Assembly/package: `PdfAPI.Core`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| IsPdfa | `bool IsPdfa { get; }` | Indicates whether the configured `OutputFormat` is PDF/A. |
| OutputFormat | `PdfFormat OutputFormat { get; set; }` | The requested output document format. |
| PreventOutputFileTransfer | `bool PreventOutputFileTransfer { get; set; }` | Whether the output file should be prevented from being transferred onward. |
| CleanupInputFile | `bool CleanupInputFile { get; set; }` | Whether the source file should be deleted from disk after (or before) validation. ([BR-07](../../business-rules.md#br-07-input-file-cleanup-after-load)) |
| PdfOptions() (3 overloads) | Three public constructors | Construct options with differing combinations of default and explicit values. |

## Behavioral notes
- `IsPdfa` is computed from `OutputFormat` rather than stored independently.*
- When `Options` is null on a `Document`/request, [Validate a document](../../operations/op-02-validate-a-document.md) treats cleanup as enabled by default. ([BR-07](../../business-rules.md#br-07-input-file-cleanup-after-load))

## Constraints and usage notes
- Set `OutputFormat` to `PdfA` to make `IsPdfa` return `true`; there is no independent setter.

> **Note:** Statements marked with `*` were inferred from code structure, naming
> conventions, or contextual evidence where direct confirmation was not available
> in source artifacts.

## Related documentation
- [Index](../../index.md)
- [Overview](../../overview.md)
- [Architecture](../../architecture.md)
- [Dependencies](../../dependencies.md)
- [Operations and processes](../../operations-processes.md)
- [Business rules](../../business-rules.md)
- [Security and authorization](../../security-authorization.md)
- [API reference](../index.md)

## Sources
- `PdfAPI.Core\PdfOptions.cs`